Skip to main content

Double Open Server

DOS

A wrapper for the Double Open Server.

Description​

The DOS scanner wrapper is a client for the scanner API implemented as part of the Double Open Server. The server runs ScanCode in the backend and stores / reuses scan results on a per-file basis and thus uses its own scan storage.

Configuration​

Example​

Use the following syntax to configure this plugin globally as part of config.yml:

ort:
  scanner:
    scanners:
      DOS:
        options:
          url: <OPTIONAL_STRING>
          timeout: <OPTIONAL_LONG>
          pollInterval: 5
          frontendUrl: "http://localhost:3000"
          writeToStorage: true
        secrets:
          token: <OPTIONAL_SECRET>

Options​

url​

STRING Required

The URL where the DOS backend is running.

token​

SECRET Required

The secret token to use with the DOS backend.

timeout​

LONG

The timeout for communicating with the DOS backend, in seconds.

pollInterval​

LONG Default

Interval (in seconds) to use for polling scanjob status from DOS API.

frontendUrl​

STRING Default

The URL where the DOS / package curation front-end is running.

writeToStorage​

BOOLEAN Default

Whether to write scan results to the storage.